<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: cfg/dynamic_cfg_context.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_cfb2ffb2869bbb27b7281952022eb856.html">cfg</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">dynamic_cfg_context.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="dynamic__cfg__context_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="cfg__fwd_8hpp.html">flow/cfg/cfg_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &lt;boost/function.hpp&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &lt;algorithm&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1cfg.html">flow::cfg</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"></span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">/**</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * Class which facilitates managing access to a dynamic configuration.  Another class can make use of this one by means</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * of a composition relationship, either through inheritance (probably `private` or `protected`) or by containing one or</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * more `Dynamic_cfg_context` members.  If using inheritance, the class will gain methods which can be used to access</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * the dynamic configuration.  If using composition by members, more than one dynamic configuration can be used, each of</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * which can be accessed separately by calling the access methods of the associated member.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> *</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * A &quot;configuration,&quot; here, is a data object (probably a `struct`), which is referred to as the &quot;root&quot;, containing an</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * internal data object, which is referred to as the &quot;target&quot;.  The target is the configuration object which is expected</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * to be normally accessed.  The root and the target can be the same.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> *</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * @tparam Root</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> *         Type for the root configuration.  This should meet the requirements of the template argument for</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> *         `Option_set`.  A `Root::Const_ptr` type for a ref-counted pointer to an immutable `Root` must at least be</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> *         defined (which can be provided by deriving from `util::Shared_ptr_alias_holder`).  See Option_set.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * @tparam Target</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *         Type for the target configuration.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * @tparam Target_ptr</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *         Please leave this at its default.  Background: This would not have been a template parameter in the</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *         first place, had the authors known of `pointer_traits::rebind` at that the time.  To preserve</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> *         backwards compatibility this parameter remains for now (albeit deprecated).</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * @todo flow::cfg::Dynamic_cfg_context `Target_ptr` is deprecated and shall be always left at its default</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *       value in future code; eventually remove it entirely and hard-code the default value internally.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> */</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Root, <span class="keyword">typename</span> Target,</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>         <span class="keyword">typename</span> Target_ptr&gt; <span class="comment">// See default in _fwd.hpp.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html">   56</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html">Dynamic_cfg_context</a></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>{</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>  <span class="keyword">static_assert</span>(std::is_same_v&lt;typename Target_ptr::element_type, std::add_const_t&lt;Target&gt;&gt;,</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>                <span class="stringliteral">&quot;The `element_type` of `Target_ptr` must be `const Target`.&quot;</span>);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"></span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">  /// Type alias for `Target_ptr`.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#ab1a92aa896e67105e271dfdc2f34e6f8">   65</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#ab1a92aa896e67105e271dfdc2f34e6f8">Target_ptr_type</a> = Target_ptr;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"></span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment">  /// Type for a function object which returns a ref-counted pointer to an immutable root configuration object.</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a971da5a0f825e0104f5dd1ff95068fec">   68</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classflow_1_1Function.html">Get_root_func</a> = <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;<span class="keyword">typename</span> Root::Const_ptr ()&gt;;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"></span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">  /// Type for a function object which translates a `Root` object to a contained `Target` object.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#ae3196f7977575e45bc21bee7cf38f122">   71</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classflow_1_1Function.html">Root_to_target_func</a> = <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;<span class="keyword">const</span> Target&amp; (<span class="keyword">const</span> Root&amp;)&gt;;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"></span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">   * Constructor.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">   *</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">   * @param get_root_func_moved</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">   *        Returns a ref-counted pointer to the (immutable) root configuration object.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">   * @param root_to_target_func_moved</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">   *        Translates a root configuration object to a contained target configuration object.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">   */</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>  <a class="code hl_function" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#ae0bb63a2cbc720d96e9349440281534e">Dynamic_cfg_context</a>(<a class="code hl_class" href="classflow_1_1Function.html">Get_root_func</a>&amp;&amp; get_root_func_moved, <a class="code hl_class" href="classflow_1_1Function.html">Root_to_target_func</a>&amp;&amp; root_to_target_func_moved);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"></span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">   * Constructor.</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">   *</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">   * This produces a `Dynamic_cfg_context` which will obtain its configuration from a `Config_manager`.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">   *</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">   * @param config_manager</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">   *        A `Config_manager` which is currently managing the desired dynamic configuration.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">   * @param root_to_target_func_moved</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">   *        Translates a root configuration object to a contained target configuration object.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">   * @param d_value_set_idx</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">   *        The dynamic config slot index of `config_manager` which corresponds to the desired dynamic configuration.</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">   *        @see `Config_manager`.</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment">   */</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span>... S_d_value_set&gt;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>  <a class="code hl_function" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#ae0bb63a2cbc720d96e9349440281534e">Dynamic_cfg_context</a>(<span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1cfg_1_1Config__manager.html">Config_manager&lt;S_d_value_set...&gt;</a>&amp; config_manager,</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>                      <a class="code hl_class" href="classflow_1_1Function.html">Root_to_target_func</a>&amp;&amp; root_to_target_func_moved, <span class="keywordtype">size_t</span> d_value_set_idx = 0);</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"></span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment">   * Obtain the root configuration.</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">   *</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">   * @return a ref-counted pointer to the (immutable) root configuration object.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment">   */</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>  <span class="keyword">typename</span> Root::Const_ptr <a class="code hl_function" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a6c82e621aac76a1bf954dea71df09cbf">root_dynamic_cfg</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"></span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">   * Obtain the target configuration.</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">   *</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">   * This method provides the key mechanism of the class.  The returned pointer object can be used to easily access the</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   * target object, but will additionally cause the containing root object to be held valid in memory.</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   *</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment">   * @return a ref-counted pointer to the (immutable) target configuration object, but which shares ownership of the</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment">   *         containing root configuration object.</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">   */</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span>  Target_ptr <a class="code hl_function" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a64f46bad36bbdb61747bdf47ea5433f8">dynamic_cfg</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"></span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">  /// Called to obtain the root configuration.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#aba8c1ccfde9a305d67ceeb4514a64219">  126</a></span><span class="comment"></span>  <span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1Function.html">Get_root_func</a> <a class="code hl_variable" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#aba8c1ccfde9a305d67ceeb4514a64219">m_get_root_func</a>;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"></span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">  /// Translates a root configuration object to a contained target configuration object.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a33801a2e601913865719ecb5767dd0c8">  129</a></span><span class="comment"></span>  <span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1Function.html">Root_to_target_func</a> <a class="code hl_variable" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a33801a2e601913865719ecb5767dd0c8">m_root_to_target_func</a>;</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>}; <span class="comment">// class Dynamic_cfg_context</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Root, <span class="keyword">typename</span> Target, <span class="keyword">typename</span> Target_ptr&gt;</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"><a class="line" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#ae0bb63a2cbc720d96e9349440281534e">  135</a></span><a class="code hl_function" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#ae0bb63a2cbc720d96e9349440281534e">Dynamic_cfg_context&lt;Root, Target, Target_ptr&gt;::Dynamic_cfg_context</a></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>  (<a class="code hl_class" href="classflow_1_1Function.html">Get_root_func</a>&amp;&amp; get_root_func_moved, <a class="code hl_class" href="classflow_1_1Function.html">Root_to_target_func</a>&amp;&amp; root_to_target_func_moved) :</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>  m_get_root_func(std::move(get_root_func_moved)),</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>  m_root_to_target_func(std::move(root_to_target_func_moved))</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>{</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>}</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span> </div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Root, <span class="keyword">typename</span> Target, <span class="keyword">typename</span> Target_ptr&gt;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span>... S_d_value_set&gt;</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"><a class="line" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a41c9e9a2427d273d021062293e99e102">  144</a></span><a class="code hl_function" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#ae0bb63a2cbc720d96e9349440281534e">Dynamic_cfg_context&lt;Root, Target, Target_ptr&gt;::Dynamic_cfg_context</a></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>  (<span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1cfg_1_1Config__manager.html">Config_manager&lt;S_d_value_set...&gt;</a>&amp; config_manager, <a class="code hl_class" href="classflow_1_1Function.html">Root_to_target_func</a>&amp;&amp; root_to_target_func_moved,</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>   <span class="keywordtype">size_t</span> d_value_set_idx) :</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>  m_get_root_func([&amp;config_manager, d_value_set_idx]()</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>  {</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>    <span class="keywordflow">return</span> config_manager.template dynamic_values&lt;Root&gt;(d_value_set_idx);</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span>  }),</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>  m_root_to_target_func(std::move(root_to_target_func_moved))</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>{</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>}</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span> </div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Root, <span class="keyword">typename</span> Target, <span class="keyword">typename</span> Target_ptr&gt;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"><a class="line" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a6c82e621aac76a1bf954dea71df09cbf">  156</a></span><span class="keyword">typename</span> Root::Const_ptr <a class="code hl_function" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a6c82e621aac76a1bf954dea71df09cbf">Dynamic_cfg_context&lt;Root, Target, Target_ptr&gt;::root_dynamic_cfg</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>  <span class="keywordflow">return</span> m_get_root_func();</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span>}</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span> </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Root, <span class="keyword">typename</span> Target, <span class="keyword">typename</span> Target_ptr&gt;</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"><a class="line" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a64f46bad36bbdb61747bdf47ea5433f8">  162</a></span>Target_ptr <a class="code hl_function" href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a64f46bad36bbdb61747bdf47ea5433f8">Dynamic_cfg_context&lt;Root, Target, Target_ptr&gt;::dynamic_cfg</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>  <span class="keyword">auto</span> root = root_dynamic_cfg();</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>  <span class="comment">/* This aliasing constructor provides the key mechanism: the constructed pointer object *shares ownership* of `root`,</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment">   * but *stores* (and operates on) a pointer to the target object (contained by and translated from `root`). */</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span>  <span class="keywordflow">return</span> Target_ptr(root, &amp;(m_root_to_target_func(*root)));</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span>}</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span> </div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>} <span class="comment">// namespace flow::cfg</span></div>
<div class="ttc" id="acfg__fwd_8hpp_html"><div class="ttname"><a href="cfg__fwd_8hpp.html">cfg_fwd.hpp</a></div></div>
<div class="ttc" id="aclassflow_1_1Function_html"><div class="ttname"><a href="classflow_1_1Function.html">flow::Function</a></div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00512">common.hpp:512</a></div></div>
<div class="ttc" id="aclassflow_1_1cfg_1_1Config__manager_html"><div class="ttname"><a href="classflow_1_1cfg_1_1Config__manager.html">flow::cfg::Config_manager</a></div><div class="ttdoc">Manages a config setup, intended for a single daemon process, by maintaining 1 or more set(s) of stat...</div><div class="ttdef"><b>Definition:</b> <a href="cfg__manager_8hpp_source.html#l00383">cfg_manager.hpp:385</a></div></div>
<div class="ttc" id="aclassflow_1_1cfg_1_1Dynamic__cfg__context_html"><div class="ttname"><a href="classflow_1_1cfg_1_1Dynamic__cfg__context.html">flow::cfg::Dynamic_cfg_context</a></div><div class="ttdoc">Class which facilitates managing access to a dynamic configuration.</div><div class="ttdef"><b>Definition:</b> <a href="dynamic__cfg__context_8hpp_source.html#l00056">dynamic_cfg_context.hpp:57</a></div></div>
<div class="ttc" id="aclassflow_1_1cfg_1_1Dynamic__cfg__context_html_a33801a2e601913865719ecb5767dd0c8"><div class="ttname"><a href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a33801a2e601913865719ecb5767dd0c8">flow::cfg::Dynamic_cfg_context::m_root_to_target_func</a></div><div class="ttdeci">const Root_to_target_func m_root_to_target_func</div><div class="ttdoc">Translates a root configuration object to a contained target configuration object.</div><div class="ttdef"><b>Definition:</b> <a href="dynamic__cfg__context_8hpp_source.html#l00129">dynamic_cfg_context.hpp:129</a></div></div>
<div class="ttc" id="aclassflow_1_1cfg_1_1Dynamic__cfg__context_html_a64f46bad36bbdb61747bdf47ea5433f8"><div class="ttname"><a href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a64f46bad36bbdb61747bdf47ea5433f8">flow::cfg::Dynamic_cfg_context::dynamic_cfg</a></div><div class="ttdeci">Target_ptr dynamic_cfg() const</div><div class="ttdoc">Obtain the target configuration.</div><div class="ttdef"><b>Definition:</b> <a href="dynamic__cfg__context_8hpp_source.html#l00162">dynamic_cfg_context.hpp:162</a></div></div>
<div class="ttc" id="aclassflow_1_1cfg_1_1Dynamic__cfg__context_html_a6c82e621aac76a1bf954dea71df09cbf"><div class="ttname"><a href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#a6c82e621aac76a1bf954dea71df09cbf">flow::cfg::Dynamic_cfg_context::root_dynamic_cfg</a></div><div class="ttdeci">Root::Const_ptr root_dynamic_cfg() const</div><div class="ttdoc">Obtain the root configuration.</div><div class="ttdef"><b>Definition:</b> <a href="dynamic__cfg__context_8hpp_source.html#l00156">dynamic_cfg_context.hpp:156</a></div></div>
<div class="ttc" id="aclassflow_1_1cfg_1_1Dynamic__cfg__context_html_ab1a92aa896e67105e271dfdc2f34e6f8"><div class="ttname"><a href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#ab1a92aa896e67105e271dfdc2f34e6f8">flow::cfg::Dynamic_cfg_context::Target_ptr_type</a></div><div class="ttdeci">Target_ptr Target_ptr_type</div><div class="ttdoc">Type alias for Target_ptr.</div><div class="ttdef"><b>Definition:</b> <a href="dynamic__cfg__context_8hpp_source.html#l00065">dynamic_cfg_context.hpp:65</a></div></div>
<div class="ttc" id="aclassflow_1_1cfg_1_1Dynamic__cfg__context_html_aba8c1ccfde9a305d67ceeb4514a64219"><div class="ttname"><a href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#aba8c1ccfde9a305d67ceeb4514a64219">flow::cfg::Dynamic_cfg_context::m_get_root_func</a></div><div class="ttdeci">const Get_root_func m_get_root_func</div><div class="ttdoc">Called to obtain the root configuration.</div><div class="ttdef"><b>Definition:</b> <a href="dynamic__cfg__context_8hpp_source.html#l00126">dynamic_cfg_context.hpp:126</a></div></div>
<div class="ttc" id="aclassflow_1_1cfg_1_1Dynamic__cfg__context_html_ae0bb63a2cbc720d96e9349440281534e"><div class="ttname"><a href="classflow_1_1cfg_1_1Dynamic__cfg__context.html#ae0bb63a2cbc720d96e9349440281534e">flow::cfg::Dynamic_cfg_context::Dynamic_cfg_context</a></div><div class="ttdeci">Dynamic_cfg_context(Get_root_func &amp;&amp;get_root_func_moved, Root_to_target_func &amp;&amp;root_to_target_func_moved)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="dynamic__cfg__context_8hpp_source.html#l00135">dynamic_cfg_context.hpp:136</a></div></div>
<div class="ttc" id="anamespaceflow_1_1cfg_html"><div class="ttname"><a href="namespaceflow_1_1cfg.html">flow::cfg</a></div><div class="ttdoc">Flow module that facilitates configuring modules, such as applications and APIs, via statically and/o...</div><div class="ttdef"><b>Definition:</b> <a href="cfg__fwd_8hpp_source.html#l00111">cfg_fwd.hpp:112</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
